home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / bbs / timlk30u.zip / TIMELOCK.DOC < prev    next >
Text File  |  1992-05-01  |  18KB  |  399 lines
  1.                              TIMELOCK
  2.            THE TIME MANAGEMENT SYSTEM FOR BBS DOORS AND PROGRAMS
  3.      
  4.      INTRODUCTION
  5.      ───────────────────────────────────────────────────────────────────
  6.           TimeLock  is  a  simple, yet  powerful  BBS,  Time  Management 
  7.           Program.   It enables Sysops to restrict access to BBS  Nodes, 
  8.           HUB  mail  doors, game  doors or, any other  BBS  door/utility 
  9.           program  during  specific times of the day  or  night.    Only 
  10.           designated  callers (or groups) can access a BBS node or  door 
  11.           program  during  a Sysop defined time slot  when  the  correct 
  12.           caller ID or password is provided.
  13.      
  14.      FOR NETMAIL HUBS
  15.           NetMail HUB Sysops!  You can now be sure that only  designated 
  16.           nodes  and hubs will access your BBS or Mail doors during  the 
  17.           Time Slots you assign.   No longer will you see your nodes and 
  18.           hubs  calling  outside  their designated  time  slots  bumping 
  19.           someone else out of their time slot.  Now you can truly  offer 
  20.           PROTECTED TIME SLOTS to your nodes and hubs.
  21.      
  22.      HOW TIMELOCK WORKS
  23.           TimeLock.EXE   can be placed in your board.bat, logon door (if
  24.           your  BBS  provides this feature) or in any  batch  file  that 
  25.           calls  a door or utility program.   When a caller attempts  to 
  26.           open a TimeLock Protected NODE, DOOR, or PROGRAM, TimeLock  is 
  27.           executed  first  and  determines whether the  caller  will  be 
  28.           allowed access based on the time slot assigned to them.  If in 
  29.           their  timeslot, TimeLock returns an error level of  zero.  If 
  30.           the caller is not in their timeslot, TimeLock returns an error 
  31.           level of 255 (user definable error level  or DTR to disconnect
  32.           in Registered Version).   Based  on  these errorlevels you can
  33.           allow the caller to continue, return the to the board (or even
  34.           log them off).
  35.      
  36.      SUMMARY OF TIMELOCK FEATURES
  37.      *   Allows  BBS  Sysops to restrict access to a BBS  NODE,  DOOR  or     
  38.          PROGRAM to designated callers and time periods.
  39.      
  40.      *   Written for PC Board, GAP, Wildcat and any other broad  capable     
  41.          of producing a DOOR.SYS file.  
  42.      
  43.      *   Prints schedule to Screen, File or Printer. Supports both  ASCII         
  44.          and ANSI Schedule Bulletin or News File (sysop definable).
  45.      
  46.      *   Allows for overlapping time slots permitting access to GROUPS of 
  47.          callers.
  48.      
  49.      *   Validate callers time slot using PASSWORD or CALLERID (username).
  50.      
  51.      *   Detailed Usage Log (* Registered Version).
  52.      
  53.      *   Multi-Node Operation (* Registered Version).
  54.      
  55.      *   User  Definable  Default  Time  Increments   when   establishing     
  56.          schedule database (* Registered Version).
  57.      
  58.      *   Sysop definable errorlevel  if caller is not in their  timeslot. 
  59.          (* Registered Version).
  60.      
  61.      *   Can retrieve PASSWORD or CALLER ID without user intervention. (* 
  62.          Registered Version).
  63.  
  64.  
  65.                                     ( -1- )
  66.  
  67.  
  68.  
  69.  
  70.      OVERVIEW OF TIMELOCK OPERATION
  71.      ───────────────────────────────────────────────────────────────────
  72.           The TimeLock system consists of two parts. TIMEDATA.EXE,  that 
  73.           allows  you to establish a schedule of callers and their  time 
  74.           slots.  And  TIMELOCK.EXE, that checks whether the  caller  is 
  75.           authorized to access the BBS or program during the time period 
  76.           called. 
  77.      
  78.      The TIMEDATA.EXE Program
  79.           TimeData   allows  you  to  create  a  database  containing  a 
  80.           starting  and  ending time (a Time Slot), a caller name or  ID 
  81.           (this   can be  a  HUB or  Node ID or  a users name), and    a  
  82.           password  as  shown   below.   Remember the "open" time  slots 
  83.           are  defined  by  those times for  which  no  TimeData  record 
  84.           covers and they are open to all users.
  85.           
  86.      Sample TimeData screen:
  87.      
  88.      | START  |  END  |   Caller ID                  |  Password      |
  89.      
  90.      20:00    20:15     HUBWOCKY                       XYZ123
  91.      20:15    20:30     THDOOR                         WEBSTER
  92.      20:30    21:00     HUBNY                          ALPHA
  93.           
  94.      The TIMELOCK.EXE Program
  95.           TimeLock  checks the database when the caller tries to open  a  
  96.           door  or  execute  a program protected by  TimeLock.   If  the 
  97.           password or callerid  provided (either thru entry or from  the 
  98.           system  file)  is valid  for  the   current  timeslot,    then  
  99.           TimeLock  returns an errorlevel of 0.  If it is not valid  for 
  100.           the current timeslot, TimeLock returns  errorlevel 255, or the  
  101.           exit  errorlevel  as  established  in  the configuration file.  
  102.           By testing for these errorlevels  in your  door batch   files, 
  103.           you  can  grant  or  deny access  to  the  program  or   door.  
  104.           (REGISTERED  USERS!  When  selecting  your  exit   errorlevel, 
  105.           remember  that  some  BBS  software  allows   activation    of  
  106.           various   features  when  an  errorlevel   is returned.    For 
  107.           example,  in GAP, an errorlevel of  62 (twit  key)  causes the 
  108.           carrier  to be dropped, disconnecting the  user and  recycling 
  109.           the board.)
  110.           
  111.      EXAMPLE: USING TIMELOCK FOR A HUB MAIL DOOR  
  112.      
  113.                 REM  HUBRIME.BAT
  114.                 echo off
  115.                 TimeLock TimeLock.CNF
  116.                 If errorlevel = 255 goto end
  117.                 F:
  118.                 cd F:\RIME\HUB
  119.                 rem run the HUB with the proper configuration file
  120.                 HUB CONFIG3.HUB REMOTE
  121.                 :end
  122.      
  123.           In  the  above example, when the Node or HUB calls  and  opens  
  124.           your Mail  Door,  TimeLock  either  requests  or  retrieves  a  
  125.           password or a caller ID.  If the password/caller id is correct 
  126.           for the current timeslot, an  errorlevel of 0 is  returned and 
  127.           the   batch  file allows the caller to open  the  mail   door.   
  128.           If it is incorrect, TimeLock   returns  an errorlevel of  255.  
  129.           The  caller  is  not permitted to open the mail  door  and  is 
  130.           returned to the BBS.
  131.                                     ( -2- )
  132.  
  133.  
  134.  
  135.  
  136.      INSTALLING & USING TIMELOCK:
  137.      ───────────────────────────────────────────────────────────────────
  138.                  
  139.      TIMLOKxx.ZIP contains the following files:
  140.                  
  141.           TIMELOCK.EXE - Program  that  requests  and  verifies  the
  142.                          password entered.
  143.           TIMELOCK.CNF - Sample configuration file for TimeLock.
  144.           TIMEDATA.EXE - Program  that  maintains the list  of  time
  145.                          slots and their passwords.
  146.           TIMEDATA.CNF - Sample configuration file for TimeData.
  147.           WHATS.NEW    - History of enhancements and corrections.
  148.           FILE_ID.DIZ  - Breif description file.
  149.           TIMELOCK.DOC - This file.
  150.           REGISTER.DOC - Registration form
  151.                  
  152.                  
  153.      To install TimeLock, follow the steps listed below.
  154.                  
  155.      STEP 1.   Make a directory for the TimeLock programs and files.   If 
  156.           you  are using the Shareware version, and running  multi-node, 
  157.           you  will  want  to  place  TimeLock  in  each  nodes  default 
  158.           directory.   Registered users  may  make one  area  regardless  
  159.           of the number of nodes.
  160.                  
  161.      STEP 2.   Make  configuration files.   You may use the sample  files 
  162.           (TIMELOCK.CNF   &  TIMEDATA.CNF)  for  this   purpose.    Each 
  163.           TimeLock  configuration file will contain seven (7)  lines  as 
  164.           follows.
  165.           
  166.           e:\node4            <== Path to system files
  167.           The Door            <== BBS Name
  168.           0                   <== 0=Gap/1=PC Board & Everything else
  169.           N                   <== Maintain Usage file? Y/N
  170.           Y                   <== Get password from DOOR.SYS? Y/N
  171.           62                  <== Exit errorlevel or "DTR" for bad timeslot
  172.           PASSWORD            <== Validate PASSWORD or CALLERID
  173.           e:\node4\good       <== Full path to screen for valid callers
  174.           e:\node4\bad        <== Full path to screen for invalid callers
  175.           e:\node4\open       <== Full path to screen for callers in open slot
  176.           100                 <== Exempt Security Level
  177.  
  178.      The TIMEDATA.CNF file will contain three (3) lines as follows.
  179.           
  180.                5                   <== Default Time Increment in Minutes
  181.                e:\node4\timedatg.  <== Path for ANSI bulletin/news file
  182.                e:\node4\timedat.   <== Path for ASCII bulletin/news file
  183.           
  184.      For more information about the configuration files, please view  the 
  185.      sample TIMELOCK.CNF and TIMEDATA.CNF files provided.
  186.           
  187.      STEP 3:    Establish  your time  slot database  using  the  TimeData 
  188.           program.  See page 4 for helpful hints on running this program.
  189.           
  190.      STEP 4:   Change  the batch files used to run the doors you wish  to 
  191.           protect  with  TimeLock.  (See  the  previous  example.)  Note  
  192.           that   if   you  are a registered user  you   may   pass   the   
  193.           configuration  file   name  that  you wish  to   use   on  the  
  194.           command   line.   If  this  configuration   name   is  omitted 
  195.           the TimeLock program  will  use the TIMELOCK.CNF file.)
  196.  
  197.                                     ( -3- )
  198.  
  199.  
  200.  
  201.  
  202.      USING TIMEDATA
  203.      ───────────────────────────────────────────────────────────────────
  204.      The TimeData program  allows you to establish the database  of  time 
  205.      slots   and which callerids or passwords will  activate them.   Note 
  206.      that   you  may enter the User Name, Hub Name, or Node  ID  in   the 
  207.      Caller  ID  field.
  208.           
  209.      Remember, if you are a  registered user and  you wish to   establish 
  210.      default time increments, then view and modify the TIMEDATA.CNF  file 
  211.      accordingly.   Also, you must establish your paths and filenames for 
  212.      printing your schedule to a bulletin or newsfile.
  213.           
  214.      The  TimeData  program is  very  straight  forward and easy to  use.  
  215.      However, a few helpful hints never hurt.
  216.           
  217.      1. To select a menu item you may use your arrow keys, or press   the 
  218.        first letter  of the item.  Note that  PAGE UP will function   as 
  219.        Previous, PAGE DOWN will function as Next and ESC will   function 
  220.        as Quit.   The ESC key  will also  abort the Adding &    Changing 
  221.        functions and return to the menu. 
  222.                  
  223.      2. When the  program requests  a Yes or No  response, the    default 
  224.        answer will appear in uppercase. For example, by pressing   Enter 
  225.        at the "Is this Correct? Y/n" prompt you would be selecting   the  
  226.        uppercase response, or "Y". 
  227.                  
  228.      3. Your arrow keys work in moving  around the screen and the   menu, 
  229.        but  do not  work well in editing.  So when you  are changing   a 
  230.        field, use your backspace key. 
  231.                  
  232.      4. Times  will be entered as hhmm, with no colon, it will be   added 
  233.        for  you. Make sure you pad your entries with zeros (i.e.   0500) 
  234.        and use a 24 hour clock. 
  235.                  
  236.      5. If  you established  a default  time slot  length, you will   not 
  237.        need  to enter an  Ending Time, just  press enter  and   TimeData 
  238.        will enter it for you.
  239.           
  240.      6. When  you  pRint to a file, remember that it will use  the   file 
  241.        names  that you established in the TIMEDATA.CNF file.
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.                                     ( -4- )
  264.  
  265.  
  266.  
  267.  
  268.      LEGALITIES
  269.      ───────────────────────────────────────────────────────────────────
  270.           
  271.      DISTRIBUTION
  272.           TimeLock  (Tm) is a "shareware program" and is provided at  no 
  273.           charge to the user for evaluation.  Feel free to share it with 
  274.           your  friends,  but please do not give it away altered  or  as 
  275.           part  of  another  system.  The  essence  of  "user-supported" 
  276.           software  is to provide personal computer users  with  quality 
  277.           software without high prices, and yet to provide incentive for 
  278.           programmers to continue to develop new products.  If you  find 
  279.           this  program useful and you continue to use it after a  trial 
  280.           period  of  20 days, you must make a registration  payment  of 
  281.           $15.00  to Peiman & Associates Inc.  The  $15.00  registration 
  282.           fee  will license one copy for use on any one computer at  any 
  283.           one time.     
  284.      
  285.           Commercial or business users of this package must register and 
  286.           pay  for their copies of this package within 10 days of  first 
  287.           use or their license is withdrawn.  Site-License  arrangements 
  288.           may be made by contacting Peiman & Associates, Inc.. 
  289.      
  290.           You  are  encouraged to pass a copy of this package  along  to 
  291.           others for for evaluation.  Please encourage them to  register 
  292.           their copy if they find that they can use it.  
  293.                  
  294.        Peiman & Associates, Inc.             SUPPORT BBS
  295.        629 Peachwood Drive                   The DOOR BBS & Information Network
  296.        Altamonte Springs, FL. 32714          5-Nodes US Robotics DS/V.32bis/HST
  297.        U.S.A.                                407-682-3132
  298.        (Compuserve 76630,2177)
  299.                                        
  300.      
  301.      COPYRIGHT NOTICE AND TRADEMARKS
  302.           Distribute   this   program   intact!    This   software   and 
  303.           accompanying documentation are Copyright (c) 1991 by Peiman  & 
  304.           Associates, Inc..  All rights are reserved.  All PAI  Software  
  305.           products  are trademarks or registered trademarks of Peiman  & 
  306.           Associates,   Inc..   Other  brand  and  product   names   are 
  307.           trademarks  or  registered  trademarks  of  their   respective 
  308.           holders.
  309.                  
  310.      
  311.      DISCLAIMER OF WARRANTY
  312.           Users of this package must accept this disclaimer of warranty: 
  313.           "The TimeLock program is supplied as is.  Peiman &  Associates 
  314.           disclaims  all  warranties, expressed or  implied,  including, 
  315.           without  limitation, the warranties of merchantability and  of 
  316.           fitness  for any purpose. The author assumes no liability  for 
  317.           damages,  direct or consequential, which may result  from  the 
  318.           use of these software programs."
  319.                  
  320.      
  321.      REPORTING PROBLEMS
  322.           If  you encounter any problems with TimeLock which  you  think 
  323.           might  be a bug, please report it to us at the address  above, 
  324.           or contact us on the DOOR BBS.
  325.  
  326.  
  327.  
  328.  
  329.  
  330.                                     ( -5- )
  331.  
  332.  
  333.  
  334.  
  335.      DIFFERENCES BETWEEN THE SHAREWARE AND REGISTERED VERSIONS
  336.      ───────────────────────────────────────────────────────────────────
  337.           While the shareware version of TimeLock is not crippled in any 
  338.           way, registration enables additional features and functions.
  339.      
  340.           As a registered user, you will receive:
  341.                  
  342.               o  The right to continue using TimeLock
  343.               o  The latest version of TimeLock
  344.               o  Updates for 1 Year
  345.               o  Additional Program Features  
  346.               o  Technical support via The DOOR BBS, (407-682-3132)
  347.                  
  348.      
  349.           SHAREWARE                        REGISTERED VERSION
  350.        
  351.           Allows Sysops to restrict        Allows Sysops to restrict
  352.           caller access.                   caller access.
  353.      
  354.           Written for any BBS able         Written for any BBS able 
  355.           to produce a DOOR.SYS file.      to produce a DOOR.SYS file.
  356.      
  357.           Prints Schedule to Screen,       Prints Schedule to Screen,
  358.           Printer or File (ASCII and       Printer of File (ASCII and
  359.           ANSI news files).                ANSI news files).
  360.      
  361.           Allows overlapping time          Allows overlapping time 
  362.           slots.                           slots with warning.
  363.      
  364.           Validates callers time           Validates callers time 
  365.           slot using PASSWORD or           slot using PASSWORD or 
  366.           CALLERID (username).             CALLERID (username).   
  367.      
  368.           Multi-Node operations            Multi-Node operation 
  369.           from separate directories.       from one directory
  370.      
  371.           No Usage Log                     Detailed Usage Log 
  372.      
  373.           No Default Time Increments       User Definable Default Time 
  374.                                            Increments (for quick 
  375.                                            schedule entry.)
  376.      
  377.           Returns errorlevel of 255        Returns Sysop definable
  378.           if caller is not in their        errorlevel if caller is not
  379.           timeslot.                        in their timeslot. 
  380.      
  381.           Requires user entry for          Can retrieve PASSWORD or
  382.           PASSWORD or CALLER ID.           CALLER ID without user
  383.                                            intervention.
  384.      
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.                                     ( -6- )
  397.  
  398.  
  399.